Parameter Keywords and Values for Aggregation (Oracle OLAP Analytic Workspace Java API Reference)

Oracle® OLAP Analytic Workspace Java API Reference
10g Release 2 (10.2)
B14351-02

Parameter Keywords and Values for Aggregation

The following table lists the keywords and values that are valid for a Parameter for an Aggregation. The table also contains brief descriptions of the actions specified by the keyword and values.

The items in the Keyword column are values that you can specify in a call to the setKeyWord method. The items in the Value column are values that you can specify in a call to the setValue method. You specify all values as String objects.

Keyword	Value	Description
`DIVIDEBYZERO`	`YES` `NO`	Specifies whether to allow division by zero. `YES` allows division by zero; a calculation that involves division by zero executes without error but produces `NA` results. `NO` disallows division by zero; a calculation that involves division by zero stops executing and produces an error message.
`DECIMALOVERFLOW`	`YES` `NO`	Specifies whether to allow decimal overflow, which occurs when the result of a calculation is too large to be represented by the exponent portion of the numerical representation. `YES` allows overflow; a calculation that generates overflow executes without error and produces `NA` results. `NO` disallows overflow; a calculation involving overflow stops executing and generates an error message.
`NASKIP`	`YES` `NO`	Specifies whether the aggregation operation ignores `NA` values. `YES` specifies that the aggregation operation ignores `NA` values. `NO` specifies that the aggregation operation considers `NA` values. When the operation encounters an `NA` value, the calculation returns `NA`. A `Parameter` with the `NASKIP` keyword does not effect an aggregation operation when the `AggregationOperator` value is `HAVERAGE`, `HFIRST`, `HLAST`, `HWAVERAGE`, `HWFIRST`, or `HWLAST`.
`WEIGHTBY`	weight_object	Specifies values for a weighted aggregation operation. As the weight_object value, give the name of a `Measure` or an `Attribute` that provides the weight values. You must include a `Parameter` with the `WEIGHTBY` keyword when `AggregationOperator` value is `HWAVERAGE`, `HWFIRST`, `HWLAST`, `SSUM`, `WAVERAGE`, `WFIRST`, `WLAST`, or `WSUM`. To specify a value to substitute for `NA` values in the weight_object object, use a `Parameter` with the `WNAFILL` keyword.
`WNAFILL`	wnafillval	Specifies a value to substitute for `NA` values in the weight_object specified by a `Parameter` with the `WEIGHTBY` keyword. The wnafillval value is a `String` that designates a number or `NA`. A number value is usually between 0.0 and 1.0. The default value for `HWAVERAGE` and `SSUM` operations is 0.0. The default value for the other operations is 1.0. If you want `NA` values in the weight object to remain `NA` rather than be replaced by the default value, then specify `NA` as the wnafillval value. However, for an `SSUM` operation, if wnafillval is `NA` and the value of an `NASKIP` `Parameter` is `YES`, then the aggregation operation replaces `NA` values with 0.0. If the `NASKIP` value is `NO`, then the operation does not replace `NA` values. A `Parameter` with the `WNAFILL` keyword only has an effect if the `Aggregation` has a `Parameter` with the `WEIGHTBY` keyword.